home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XmbLookupString.z / XmbLookupString
Encoding:
Text File  |  2002-10-03  |  9.4 KB  |  292 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXmmmmbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XmbLookupString, XwcLookupString - obtain composed input
  10.           from an input method
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           int XmbLookupString(_i_c, _e_v_e_n_t, _b_u_f_f_e_r__r_e_t_u_r_n, _b_y_t_e_s__b_u_f_f_e_r,
  14.           _k_e_y_s_y_m__r_e_t_u_r_n, _s_t_a_t_u_s__r_e_t_u_r_n)
  15.                 XIC _i_c;
  16.                 XKeyPressedEvent *_e_v_e_n_t;
  17.                 char *_b_u_f_f_e_r__r_e_t_u_r_n;
  18.                 int _b_y_t_e_s__b_u_f_f_e_r;
  19.                 KeySym *_k_e_y_s_y_m__r_e_t_u_r_n;
  20.                 Status *_s_t_a_t_u_s__r_e_t_u_r_n;
  21.  
  22.           int XwcLookupString(_i_c, _e_v_e_n_t, _b_u_f_f_e_r__r_e_t_u_r_n, _b_y_t_e_s__b_u_f_f_e_r,
  23.           _k_e_y_s_y_m__r_e_t_u_r_n, _s_t_a_t_u_s__r_e_t_u_r_n)
  24.                 XIC _i_c;
  25.                 XKeyPressedEvent *_e_v_e_n_t;
  26.                 wchar_t *_b_u_f_f_e_r__r_e_t_u_r_n;
  27.                 int _w_c_h_a_r_s__b_u_f_f_e_r;
  28.                 KeySym *_k_e_y_s_y_m__r_e_t_u_r_n;
  29.                 Status *_s_t_a_t_u_s__r_e_t_u_r_n;
  30.  
  31.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  32.           _b_u_f_f_e_r__r_e_t_u_r_n
  33.                     Returns a multibyte string or wide character
  34.                     string (if any) from the input method.
  35.  
  36.           _b_y_t_e_s__b_u_f_f_e_r
  37.           _w_c_h_a_r_s__b_u_f_f_e_r
  38.                     Specifies space available in the return buffer.
  39.  
  40.           _e_v_e_n_t     Specifies the key event to be used.
  41.  
  42.           _i_c        Specifies the input context.
  43.  
  44.           _k_e_y_s_y_m__r_e_t_u_r_n
  45.                     Returns the KeySym computed from the event if this
  46.                     argument is not NULL.
  47.  
  48.           _s_t_a_t_u_s__r_e_t_u_r_n
  49.                     Returns a value indicating what kind of data is
  50.                     returned.
  51.  
  52.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  53.           The _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g functions return the
  54.           string from the input method specified in the buffer_return
  55.           argument.  If no string is returned, the buffer_return
  56.           argument is unchanged.
  57.  
  58.           The KeySym into which the KeyCode from the event was mapped
  59.           is returned in the keysym_return argument if it is non-NULL
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXmmmmbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           and the status_return argument indicates that a KeySym was
  75.           returned.  If both a string and a KeySym are returned, the
  76.           KeySym value does not necessarily correspond to the string
  77.           returned.
  78.  
  79.           _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g returns the length of the string in bytes,
  80.           and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g returns the length of the string in
  81.           characters.  Both _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g return
  82.           text in the encoding of the locale bound to the input method
  83.           of the specified input context.
  84.  
  85.           Each string returned by _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g
  86.           begins in the initial state of the encoding of the locale
  87.           (if the encoding of the locale is state-dependent).
  88.  
  89.                                       Note
  90.  
  91.                (Reg.)To insure proper input processing, it is
  92.                essential that the client pass only _K_e_y_P_r_e_s_s
  93.                events to _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g.
  94.                Their behavior when a client passes a _K_e_y_R_e_l_e_a_s_e
  95.                event is undefined.
  96.  
  97.  
  98.           Clients should check the status_return argument before using
  99.           the other returned values.  These two functions both return
  100.           a value to status_return that indicates what has been
  101.           returned in the other arguments.  The possible values
  102.           returned are:
  103.           _X_B_u_f_f_e_r_O_v_e_r_f_l_o_w
  104.                             The input string to be returned is too
  105.                             large for the supplied buffer_return.  The
  106.                             required size (_X_m_b_L_o_o_k_u_p_S_t_r_i_n_g in bytes;
  107.                             _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g in characters) is returned
  108.                             as the value of the function, and the
  109.                             contents of buffer_return and keysym_return
  110.                             are not modified.  The client should recall
  111.                             the function with the same event and a
  112.                             buffer of adequate size to obtain the
  113.                             string.
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.           _X_L_o_o_k_u_p_N_o_n_e
  125.                             No consistent input has been composed so
  126.                             far.  The contents of buffer_return and
  127.                             keysym_return are not modified, and the
  128.                             function returns zero.
  130.  
  131.  
  132.  
  133.           _X_L_o_o_k_u_p_C_h_a_r_s
  134.                             Some input characters have been composed.
  135.                             They are placed in the buffer_return
  136.                             argument, and the string length is returned
  137.                             as the value of the function.  The string
  138.                             is encoded in the locale bound to the input
  139.                             context.  The content of the keysym_return
  140.                             argument is not modified.
  141.  
  142.  
  143.  
  144.  
  145.  
  146.      Page 2                                          (printed 10/3/02)
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.      XXXXmmmmbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXmmmmbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX11111111))))
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.      Page 3                                          (printed 10/3/02)
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.      XXXXmmmmbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXmmmmbbbbLLLLooooooookkkkuuuuppppSSSSttttrrrriiiinnnngggg((((3333XXXX11111111))))
  220.  
  221.  
  222.  
  223.           _X_L_o_o_k_u_p_K_e_y_S_y_m
  224.                             A KeySym has been returned instead of a
  225.                             string and is returned in keysym_return.
  226.                             The content of the buffer_return argument
  227.                             is not modified, and the function returns
  228.                             zero.
  230.  
  231.  
  232.  
  233.  
  234.           _X_L_o_o_k_u_p_B_o_t_h
  235.                             Both a KeySym and a string are returned;
  236.                             _X_L_o_o_k_u_p_C_h_a_r_s and _X_L_o_o_k_u_p_K_e_y_S_y_m occur
  237.                             simultaneously.
  239.  
  240.  
  241.  
  242.           It does not make any difference if the input context passed
  243.           as an argument to _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g and _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g is the
  244.           one currently in possession of the focus or not.  Input may
  245.           have been composed within an input context before it lost
  246.           the focus, and that input may be returned on subsequent
  247.           calls to _X_m_b_L_o_o_k_u_p_S_t_r_i_n_g or _X_w_c_L_o_o_k_u_p_S_t_r_i_n_g even though it
  248.           does not have any more keyboard focus.
  249.  
  250.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  251.           XLookupKeysym(3X11)
  252.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.      Page 4                                          (printed 10/3/02)
  289.  
  290.  
  291.  
  292.